1. Linux
    2. Windows
    3. IIS (Unavailable)
    1. Authentication Methods Overview
    2. Okta (SAML)
    3. OneLogin (SAML)
    4. Curator Users
    5. Azure AD (SAML)
    6. OneLogin (OIDC)
    7. Multifactor Authentication
    8. Signing SAML Login Requests
    9. Active Directory
    10. Windows LDAP (IIS) - DEPRECATED
    1. Windows SSL (IIS) - DEPRECATED
    2. Force SSL
    3. Linux SSL
    4. Windows SSL
    5. Basic HTTP Authentication
    1. High Availability
    1. Windows
    2. Linux
    1. Forward Proxy
    2. Reverse Proxy
    1. Getting Started
    2. Setting Up Your Portal
    3. Adding Your First Dashboard
    4. Creating Your First Page
    1. REST API Integration
    2. Tableau Cloud Setup
    3. Embed Authentication
    4. Trusted Tickets
    5. Alternative URL Routing
    6. Tableau Server Repository
    7. Tableau API Debugging
    8. API Connections Overview
    1. (Step 1) Azure App Setup
    2. (Step 2) Service Principal Setup
    3. (Step 3) Power BI Workspace Access
    4. (Step 4) Curator Connection
    5. Troubleshooting Power BI Access
    1. Integrating ThoughtSpot with Curator
    1. Replace Dashboard URLs
    2. Temporarily Disabling Connections
    1. Share Workbook
    2. Adding a Dashboard
    3. Tableau Worksheets and Stories
    4. Generating Titles
    5. Data Export
    6. Custom Views
    7. Email Subscriptions
    8. Download Workbook
    9. Pause and Resume Changes
    10. URL Action Overrides (Link Target)
    11. Dashboard Settings
    1. Adding a Pulse Metric
    1. Preloading Filters and Parameters
    2. Specify Filter Sheet
    3. Filters
    4. Parameters
    5. Hidden Sticky Filters and Parameters
    6. Apply Button
    7. Filter Categories
    8. Caching Filter and Parameter Options
    1. Updating Data Groups
    2. Sending Data to Webhooks
    3. Web Data Connector (WDC)
    4. Exporting Data
    5. Data Manager Basics
    6. Creating a Form
    7. Connecting to Data Manager
    8. User Commenting
    9. Field Calculations
    10. Mark Commenting
    11. Dashboard Feedback
    12. Importing Data
    1. Overview and Enabling
    2. Email Option
    3. Scheduled Reports
    4. Fallback Image
    5. Watermark Text
    6. Powerpoint
    1. Curator Styles
    2. Homepage
    3. Titles and Toolbars
    4. Group Overrides
    5. Page Meta Titles (SEO)
    1. Managing Menus
    2. Menu Items
    3. Restrict Access
    4. Tagged Workbooks
    5. Site Switcher
    1. Pages Overview
    2. Looker Embedding
    3. Tiles
    4. Explorer
    5. Forms
    6. Blogs
    7. User Customized Metrics
    8. Manual Embeds (iFrame)
    9. SSRS Embedding
    10. YouTube Embedding
    1. Files
    1. Hidden Content
    2. Search
    3. Keywords
    4. Favorites
    5. Featuring Content
    6. Thumbnail Preview Images
    1. Loading Screens
    1. Error Pages
    2. Tutorials
    3. Notices
    8. Email Formatting
    1. Users and Groups Overview
    2. User Sync and Membership Sync Overview
    3. Reset User's Password
    4. Frontend Users
    5. Automatic License Provisioning
    6. Just-in-time (JIT) Provisioning
    7. Username Mapping
    8. Custom Attributes
    1. Frontend User Permissions
    2. Password Change
    3. Password Reset
    4. Password Expiration and Complexity
    5. Disabling Link-preview Security
    6. User Throttling
    1. Third Party Cookies
    1. Overview
    2. Password Reset
    1. System Notifications
    2. Data Manager Notifications
    1. Troubleshooting Load Times
    2. Cache Warming
    1. Updating License Key
    1. Web Accessibility
    1. System Upgrade
    2. Disable Curator Upgrades
    3. Offline Upgrades (Airgapped)
    4. Dependency Updates
    5. Troubleshooting Upgrades
    1. Importing and Exporting
    1. Curator Backup
    2. Taking a Manual Full Backup
    3. Manual Restoration of Curator Backup
    1. Updating Curator Logging
    2. Disk Speed Metrics
    3. Server Hardening Procedures
    4. Filesystem Permissions
    5. Linux: Cron Troubleshooting
    1. Curator API Overview
    2. Curator Integration Overview
    1. Integration
    2. Curator API
    3. Tableau API
    4. Content
    5. User API
    6. Authentication
    1. Scripts
    2. Commands
    3. Subscription Routing
        1. Menu Tuning
        2. Cache Warming

      Curator API: API Docs

      Curator API

      /portal/info

      Returns all information about Curator.

      Parameters:

      boolean ini Shows PHP ini settings boolean extensions Shows loaded PHP extensions

      Returns:

      array

      Example Response:

          {
        "version": "2020.09.17-01",
        "kernel_build": 446,
        "key": "[YOUR KEY HERE]",
        "php_version": "7.2.11",
        "os": "Linux ip-XX-XX-XX-XXXus-west.compute.internal 4.14.77-86.82.amzn2.x86_64 #1 SMP Tue Dec 1 20:40:13 UTC 2018 x86_64",
        "user": "apache",
        "server_addr": "ip-XXX-XX-XX-XXX.us-west-2.compute.internal",
        "server_ips": [
            "XX.XXX.XXX.X,
            "XXX.XX.XX.XXX",
            "curatordemo.interworks.com",
            "ip-XX-XX-XX-XXX.us-west.compute.internal"
        ],
        "database": "mysql",
        "display_errors": "Off",
        "max_execution_time": "60",
        "cache": "memcached",
        "gd": true,
        "fileinfo": true,
        "zip": true,
        "zlib": true,
        "curl": true,
        "openssl": true,
        "memcached": true,
        "php_ini_path": "\/etc\/php.ini",
        "tableau_version": "2018.1",
        "php_location": "\/usr\/bin\/php",
        "is_windows": false,
        "post_max_size": "250M",
        "upload_max_filesize": "250M",
        "memory_limit": "1024M",
        "webroot": "\/var\/www\/html",
        "cron_timestamp": "2019-01-08T21:01:02+00:00",
        "writeable": true,
        "upload_max_filesize_bytes": 262144000,
        "post_max_size_bytes": 262144000,
        "memory_limit_bytes": 1073741824,
        "install_files": false,
        "cron_check": true
    }

      /portal/version

      Returns version information about the Curator portal.

      Returns:

      array

      Example Response:

          {
        "version": "2017.08.10-01"
    }

      /portal/key

      Returns key for the Curator portal.

      Returns:

      array

      Example Response:

          {
        "key": "1234-5678-9101-1112-1314"
    }

      /portal/setKey

      Sets the Curator's portal key.

      Returns:

      array

      Example Response:

          {
        "result": "Success",
        "msg": 0
    }

      /portal/upgrade

      Upgrades Curator to the latest version.

      Returns:

      array

      Example Response:

          {
        "result": "Success",
        "msg": 0
    }

      /portal/cron

      Runs the Curator Schedules.

      Returns:

      array

      Example Response:

          {
        "result": "Success",
        "msg": 0
    }

      /portal/migrations

      Runs database migrations.

      Returns:

      array

      Example Response:

          {
        "result": "Success",
        "msg": 0
    }

      /portal/clearCache

      Clears Curator cache.

      Returns:

      array

      Example Response:

          {
        "result": "Success",
        "msg": 0
    }

      /portal/phpinfo

      Returns the PHP Information Page

      Returns:

      array

      /portal/setPortalName

      Sets the Curator portal name.

      Returns:

      array

      Example Response:

          {
        "result": "Success",
        "msg": 0
    }

      /portal/octoberUpgrade

      Upgrades the underlying OctoberCMS.

      Returns:

      array

      Example Response:

          {
        "result": "Success",
        "msg": 0
    }

      /portal/export

      Exports Curator portal data.

      Parameters:

      string models (optional) Comma separated list of models to export. Default: everything. Options include:

      • api_keys
      • attributes
      • commands
      • connections
      • dashboards
      • favorites
      • files
      • filter_categories
      • filters
      • fonts
      • frontend_groups
      • frontend_group_overrides
      • groups
      • items
      • interworks_authentication_settings
      • interworks_integration_settings
      • interworks_portal_settings
      • interworks_tableauviz_settings
      • interworks_usermgmt_samlsettings
      • keywords
      • loading_screens
      • navigation
      • notices
      • pages
      • parameters
      • powerbi_dashboards
      • powerbi_reports
      • scheduledreport
      • scripts
      • slideshows
      • themes
      • tos
      • tutorials
      • user_comments

      boolean thumbnails (optional) Whether to include thumbnails in the export. Default: false.

      boolean tiles (optional) Whether the output data should use the tile information instead of export. Default: false.

      Returns:

      array

      /portal/cacheInfo

      Returns all cache information about Curator

      Parameters:boolean ini Shows PHP ini settings boolean extensions Shows loaded PHP extensions

      Returns:

      array

      Example Response:

          {
        "result": "Success",
        "msg": {
            "cms_cache_path": "5.7 KB",
            "cms_combiner_path": "964.04 KB",
            "twig_cache": "529.57 KB",
            "framework_cache": "1.05 MB",
            "thumbnails": "28.95 MB"
        }
    }

      /portal/setAnalyticsSettings

      Sets the analytics tracking settings.

      Returns:

      array

      /portal/setParameter

      Sets a system parameter.

      Parameters:Returns:

      array

      /portal/cleanSettings

      Cleans up settings data, if there are duplicates.

      Returns:

      array

      /portal/fixStoragePerms

      Attempts to fix storage file permissions, recursively.

      Returns:

      array

      /portal/checkSettings

      Check settings items.

      Returns:

      array

      /portal/downloadLog

      Exports Curator's system log data.

      Returns:

      array

      /portal/cleanUploadDir

      Cleans out old uploaded files.

      Returns:

      array

      /portal/features

      Returns information on features in use.

      Returns:

      array

      /portal/stats

      Returns stats on Curator.

      Returns:

      array

      /portal/styles

      Returns head insert and custom stylesheet from Portal Settings.

      Returns:

      array